ATI SDK/com.wallee.atisdk.terminal.payments

Package-level declarations

Types

data class AdjustReservationRequest(val transactionReferenceNumber: String, val base: BaseTransactionRequest)

Request for creating a reservation adjustment transaction context.

class AdjustReservationResult : TransactionResult

data class BaseTransactionRequest(val lineItems: List<PaymentLineItem>, val currency: String, val merchantReference: String = "", val invoiceReference: String? = null, val customerId: String? = null, val customerEmailAddress: String? = null, val billingAddress: PostalAddress? = null, val shippingAddress: PostalAddress? = null, val metadata: Map<String, String> = emptyMap(), val customText: String? = null, val language: String? = null, val panHashVariants: List<PanHashVariant> = emptyList(), val transactionRefNumber: String? = null, val showTransactionResultScreens: Boolean? = null)

Common transaction request fields shared by purchase, refund, and reservation.

CancelExecutionResult

data class CancelExecutionResult(val result: CancelExecutionStatus)

CancelExecutionStatus

enum CancelExecutionStatus : Enum<CancelExecutionStatus>

CancelReservationRequest

data class CancelReservationRequest(val transactionReferenceNumber: String, val acquirerId: String)

Request for creating a reservation cancellation transaction context.

CancelReservationResult

class CancelReservationResult : TransactionResult

CaptureRequest

data class CaptureRequest(val transactionReferenceNumber: String, val lineItems: List<PaymentLineItem>, val currency: String)

Request for creating a reservation capture transaction context.

CaptureResult

class CaptureResult : TransactionResult

CompletedTransaction

data class CompletedTransaction(val transactionReferenceNumber: String, val merchantReference: String, val acquirerId: String, val amount: BigDecimal, val currency: String, val panHash: PanHashResponse? = null, val receipt: ReceiptResult? = null, val amountTip: String? = null, val cardNumber: String? = null, val cardSequenceNumber: String? = null, val cardExpirationDate: String? = null, val cardAppLabel: String? = null, val cardAppId: String? = null, val transactionTime: String? = null, val dccTransactionAmount: String? = null, val dccTransactionCurrency: String? = null, val cvm: CvmType? = null, val amountRemaining: String? = null, val partialApproval: Boolean? = null, val cardIssuingCountry: String? = null, val paymentEntryMethod: PaymentEntryMethod? = null, val protocol: PaymentProtocol = PaymentProtocol.EP2, val protocolData: ProtocolData? = null)

Acquirer-created completed transaction data.

CvmType

enum CvmType : Enum<CvmType>

ErrorReason

data class ErrorReason(val code: String, val message: String)

LastPaymentResult

data class LastPaymentResult(val state: LastPaymentResultState, val result: TransactionResult? = null)

Lookup result for the payment-domain getLastResult operation.

LastPaymentResultState

enum LastPaymentResultState : Enum<LastPaymentResultState>

PaymentEntryMethod

enum PaymentEntryMethod : Enum<PaymentEntryMethod>

PaymentEntryMethods

object PaymentEntryMethods

PaymentLineItem

data class PaymentLineItem(val id: String, val totalAmountIncludingTax: BigDecimal, val sku: String? = null, val name: String? = null, val quantity: BigDecimal = BigDecimal.ONE, val type: PaymentLineItemType = PaymentLineItemType.PRODUCT, val discountIncludingTax: BigDecimal = BigDecimal.ZERO, val taxes: List<PaymentTax> = emptyList())

Line item used in Terminal API payment requests.

PaymentLineItemType

enum PaymentLineItemType : Enum<PaymentLineItemType>

PaymentProtocol

enum PaymentProtocol : Enum<PaymentProtocol>

PaymentTax

data class PaymentTax(val title: String, val rate: BigDecimal)

PostalAddress

data class PostalAddress(val countryCode: String, val givenName: String? = null, val familyName: String? = null, val organization: String? = null, val street: String? = null, val postcode: String? = null, val city: String? = null)

ProtocolData

data class ProtocolData(val transactionSequenceCounter: Long? = null, val authorizationResponseCode: String? = null, val authorizationCode: String? = null, val terminalID: String? = null, val resultCode: String? = null, val resultMessage: String? = null, val originalTransactionSequenceCounter: Long? = null)

Protocol-specific data associated with a completed transaction.

PurchaseResult

class PurchaseResult : TransactionResult

Receipt

data class Receipt(val content: String, val receiptType: ReceiptType, val receiptFormat: ReceiptFormat = ReceiptFormat.TEXT)

ReceiptFormat

enum ReceiptFormat : Enum<ReceiptFormat>

ReceiptResult

data class ReceiptResult(val receipts: List<Receipt>)

Receipts returned with transaction and batch results when available.

ReceiptType

enum ReceiptType : Enum<ReceiptType>

RefundRequest

data class RefundRequest @JvmOverloads constructor(val amount: BigDecimal, val transactionReferenceNumber: String? = null, val acquirerId: String? = null, val receiptFormat: ReceiptFormat = ReceiptFormat.TEXT, val showTransactionResultScreens: Boolean? = null, val currency: String = "CHF", val language: String? = null, val merchantReference: String = "", val base: BaseTransactionRequest? = null)

Request for creating a refund transaction context.

RefundResult

class RefundResult : TransactionResult

RequestOutcome

enum RequestOutcome : Enum<RequestOutcome>

ReservationResult

class ReservationResult : TransactionResult

ReservedTransaction

data class ReservedTransaction(val transactionReferenceNumber: String, val merchantReference: String, val amount: BigDecimal, val currency: String, val acquirerId: String, val panHash: PanHashResponse? = null, val receipt: ReceiptResult? = null)

Acquirer-created reservation data.

ReversalRequest

data class ReversalRequest @JvmOverloads constructor(val receiptFormat: ReceiptFormat = ReceiptFormat.TEXT, val showTransactionResultScreens: Boolean? = null)

Request for creating a void transaction context.

ReversalResult

class ReversalResult : TransactionResult

TerminalPaymentsApi

interface TerminalPaymentsApi

Terminal API payment-domain operations.

TransactionRequest